.TH E1432_SET_OCTAVE_START_FREQ 3 E1432
.SH NAME
.nf
e1432_set_octave_start_freq \- Set Octave start frequency band
e1432_get_octave_start_freq \- Get Octave start frequency band
e1432_set_octave_stop_freq \- Set Octave stop frequency band
e1432_get_octave_stop_freq \- Get Octave stop frequency band
.IX e1432_set_octave_start_freq(3) 3
.IX e1432_get_octave_start_freq(3) 3
.IX e1432_set_octave_stop_freq(3) 3
.IX e1432_get_octave_stop_freq(3) 3
.SH SYNOPSIS
.cS
SHORTSIZ16 e1432_set_octave_start_freq(E1432ID hw, SHORTSIZ16 ID,
                                       FLOATSIZ32 octave_start_freq)
SHORTSIZ16 e1432_get_octave_start_freq(E1432ID hw, SHORTSIZ16 ID,
                                       FLOATSIZ32 *octave_start_freq)
SHORTSIZ16 e1432_set_octave_stop_freq(E1432ID hw, SHORTSIZ16 ID,
                                      FLOATSIZ32 octave_stop_freq)
SHORTSIZ16 e1432_get_octave_stop_freq(E1432ID hw, SHORTSIZ16 ID,
                                      FLOATSIZ32 *octave_stop_freq)
.cE
.SH DESCRIPTION

\fIe1432_set_octave_start_freq\fR and \fIe1432_set_octave_stop_freq\fR
set the start frequency band and stop frequency band, respectively,
of the modules(s) selected to the value given in
\fIoctave_start_freq\fR and \fIoctave_stop_freq\fR, respectively.

\fIe1432_get_octave_start_freq\fR and \fIe1432_get_octave_stop_freq\fR
return the start frequency band and stop frequency band, respectively,
of the modules(s) selected into a memory location pointed to by
\fIoctave_start_freq\fR and \fIoctave_stop_freq\fR, respectively..

This parameter is a "global" parameter.  It applies to an entire
module rather than to one of its channels.  The \fIID\fR parameter is
used only to identify which module the function applies to, and all
channels in that module will report the same value for this parameter.

\fIhw\fR must be the result of a successful call to
\fIe1432_assign_channel_numbers\fR, and specifies the group of
hardware to talk to.

\fIID\fR is either the ID of a group of channels that was obtained
with a call to \fIe1432_create_channel_group\fR, or the ID of a single
channel.
It is used to determine which module(s) in \fIhw\fR to set/query.

\fIoctave_start_freq\fR and \fIoctave_stop_freq\fR are rounded to the
nearest third octave band center, with a minimum \fIoctave_start_freq\fR
of 3.15 Hz and a maximum \fIoctave_stop_freq\fR of 20.0 kHz.
The maximum \fIoctave_start_freq\fR is 10.0 kHz or \fIoctave_stop_freq\fR,
whichever is lesser.
The minimum \fIoctave_stop_freq\fR is 6.3 Hz or \fIoctave_start_freq\fR,
whichever is greater.
When a Full Octave measurement is running, the start and stop bands are
the standard Full Octave bands containing
\fIoctave_start_freq\fR and \fIoctave_stop_freq\fR, respectively.

Since \fIoctave_start_freq\fR and \fIoctave_stop_freq\fR change the number
of data points transferred by the e1432_read_XXXXXXX_data functions,
the \fIe1432_get_octave_blocksize\fR function has been provided to supply the
value need for the \fIsize\fR parameter of the e1432_read_XXXXXXX_data
functions.

.SH "RESET VALUE"
After a reset, \fIoctave_start_freq\fR is set to 3.15 Hz
and \fIoctave_stop_freq\fR is set to 20.0 kHz.
.SH "RETURN VALUE"
Return 0 if successful, a (negative) error number otherwise.
.SH "SEE ALSO"
.na
e1432_set_octave_mode,
e1432_set_octave_avg_mode,
e1432_set_octave_hold_mode,
e1432_set_octave_int_time,
e1432_set_octave_time_const,
e1432_set_octave_time_step,
e1432_octave_ctl,
e1432_get_octave_blocksize,
e1432_set_filter_settling_time,
e1432_get_current_data
.ad
